/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.client.util;

import java.util.Date;

/**
 * Ticket représentant le chargement d'un traitement asynchrone. Ce ticket
 * contient une référence du chargement afin qu'il puisse être identifié et un
 * message qui sera affiché à l'écran.
 */
public final class LoadingTicket implements Comparable<LoadingTicket> {

	/**
	 * Classe dédiée à la création des instances de {@link LoadingTicket}.
	 */
	public static final class Factory {

		/**
		 * Crée un ticket avec une nouvelle référence et un message.
		 * 
		 * @param launcherClass
		 *            {@link Class} de l'élément ayant déclenché le traitement
		 *            asynchrone.
		 * @param loadingMessage
		 *            message qui sera affiché à l'écran.
		 */
		public static LoadingTicket createTicket(Class<?> launcherClass,
				String loadingMessage) {
			LoadingTicket ticket = new LoadingTicket();
			ticket.reference = createReference(launcherClass);
			ticket.message = loadingMessage;
			return ticket;
		}

		/**
		 * Crée un ticket avec une nouvelle référence.
		 * 
		 * @param launcherClass
		 *            {@link Class} de l'élément ayant déclenché le traitement
		 *            asynchrone.
		 */
		public static LoadingTicket createTicket(Class<?> launcherClass) {
			LoadingTicket ticket = new LoadingTicket();
			ticket.reference = createReference(launcherClass);
			return ticket;
		}

		/**
		 * Création d'une nouvelle référence.
		 */
		private static String createReference(Class<?> aClass) {
			Date now = new Date();

			StringBuffer referenceBuffer = new StringBuffer();
			referenceBuffer.append(now.getTime());
			referenceBuffer.append("-");
			referenceBuffer.append(aClass.getName());

			return referenceBuffer.toString();
		}
	}

	private String reference;
	private String message;

	/**
	 * Construit une nouvelle instance de {@link LoadingTicket}.
	 */
	private LoadingTicket() {

	}

	/**
	 * Référence du ticket.
	 */
	public String getReference() {
		return reference;
	}

	/**
	 * Message du chargement.
	 */
	public String getMessage() {
		return message;
	}

	@Override
	public boolean equals(Object obj) {
		if (obj == null || !(obj instanceof LoadingTicket)) {
			return false;
		}

		LoadingTicket otherTicket = (LoadingTicket) obj;
		if (this.reference == null) {
			return super.equals(obj);
		} else {
			return this.reference.equals(otherTicket.reference);
		}
	}

	@Override
	public int compareTo(LoadingTicket o) {
		return this.reference.compareTo(o.reference);
	}
}
